home *** CD-ROM | disk | FTP | other *** search
/ Aminet 8 / Aminet 8 (1995)(GTI - Schatztruhe)[!][Oct 1995].iso / Aminet / comm / misc / acidman.lha / ACIDMAN.doc < prev    next >
Text File  |  1995-08-03  |  15KB  |  218 lines

  1. ACIDMAN: The Program
  2.  
  3.  
  4. INTRODUCTION
  5.  
  6.  
  7.  ·  Faster than a speeding bullet (well, maybe if you're running a 68060), more powerful than a locomotive (at least the one I bought my nephew for Xmas), able to leap tall buildings in a single bound (if there made from lego's)....Look,....up in the sky,....it's a bird,....it's a plain, (it's a frog,.... sorry sweet Pauly), ....No,....it's ACIDMAN.
  8.  
  9.  
  10. WHAT IS IT?
  11.  
  12. ·  Over 2 years in the making (I worked on it maybe once a week for a couple hours), ACIDMAN is an acronym for Amiga Caller ID Manager.  It is a database and more program for people who have Caller ID modems, and also subscribe to a Caller ID service through their local phone company.  For those of you who do not have Caller ID, fear not.  ACIDMAN also comes with ACIDTEST, which will allow you to put ACIDMAN though it's paces, and determine if Caller ID is something you might like, and if ACIDMAN would be useful to you. 
  13.  
  14.  
  15. PREFACE
  16.  
  17. ·  Well over a year ago, Caller ID came to Peoria Illinois (my hometown).  Since I had recently purchased a Supra Modem, with Caller ID roms, I was excited (well, maybe just moderatly pleased).  I was not happy with any of the commercial Caller ID boxes available, and being quite creative, felt I could program something much better for the Amiga.  Having recently purchased CANDO, I thought this would be a good way to familiarize myself with "visual programming".  After a year and a half of struggling with CANDO, and the constant brainstorm of new ideas, I finally had a version I felt was worthy of release to the Amiga Community.  But I didn't release it then.  Now, six months later, and several more improvements and bug fixes, I'm ready to unleash the beast.  Don't misunderstand, CANDO is great, but I came from the school of "Line by Line" programming, and this was something quite different.  Also, don't discredit this program, just because it was programmed in CANDO.  It works very well, as long as you follow the instructions contained later in this documentation. 
  18.  
  19.  
  20. LEGAL STUFF
  21.  
  22. ·  I, Rob Williams, hereby copyright this program, August 1995, and am not responsible if it damages any of your equipment, ruins your life, or in anyway causes you harm, distress, or any other problems.  There's no way, to my knowledge it can, but this cover's my rearend.  Perhaps you might suffer from mental anguish from knowing in advance the IRS or your ex-wife was calling!
  23.  
  24. ·  I hereby give permission to Fred Fish (or is that Mr. Fish?), to distribute the unregistered version on his disk collection, if he so desires.  If anyone knows how to submit something to the FF collection, feel free to send the complete ACIDMAN archive, as described later.  I will also see about posting this to Aminet, which, if that's where you got it, I succeeded.
  25.  
  26.  
  27. SYSTEM REQUIREMENTS
  28.  
  29. ·  Barely runs on a stock Amiga 500 with 1 meg of ram.  For low memory systems, I recommend turning off the animation and sound, discussed in the Tool Types section.  Serial Manager is 
  30.  
  31.  
  32. INSTALLATION
  33.  
  34. ·  If you've unarched the file and are reading this, all the needed files should be in a drawer called ACIDMAN.  Simply edit your user-startup to include an ACIDMAN assign to that directory.
  35.  
  36.  
  37. QUICK TEST
  38.  
  39. After the installation has been finished and your ACIDMAN: assign made, try the following (do not worry about any tool types, and don't change the database):
  40.  
  41.     Load up ACIDTEST
  42.  
  43.     Load up ACIDMAN
  44.  
  45.     On ACIDTEST interface, type "TestMe" in the ListenPort field (no quotes)
  46.  
  47.     Click the "Test Button"
  48.  
  49. If all went well, a little animation of a phone ringing should appear, then disapear.  The Reply port should show the data sent from ACIDMAN.  ACIDMAN's interface should reflect that I called you at 4:00am on October 31(yes, that's my phone number in the database).  Now try this:
  50.  
  51.     Delete "TestMe" from the ACIDTEST Listen Port.
  52.  
  53.     Change the ACIDTEST phone number to 3095551212
  54.  
  55.     Click on "Test Button"
  56.  
  57. This time, ACIDTEST should report back a call from John Doe.  To test the Arexx abilities of ACIDTEST further, try this:
  58.  
  59.     Delete all information in the ACIDTEST reply field.
  60.  
  61.     Type "ModemOUT" in the ACIDTEST Talk Port field (case sensative)
  62.  
  63.     Type "INQUIRE" in the ACIDTEST Command field.
  64.  
  65.     Check the Arexx radio button on the ACIDTEST interface
  66.  
  67.     Click on the "Test Button"
  68.  
  69. This time, the same information about John Doe should reappear in the Reply field on ACIDTEST.  If you really have caller ID and two phone lines, enter the data for your second phone line in the database, then place the call.   You may have to change some tool types if you're not using the standard serial.device unit 0.  Testing should reflect the appropriate information.  Now read on, to find out how all of ACIDMAN's features work.
  70.  
  71.  
  72. MEAT AND POTATOES (How do I use this darn thing!)
  73.  
  74. ·  First off, it maybe neccessary to configure some tool types.   Most are self explanatory.      ·  DEVICE=name-of-serial-device (default serial.device)
  75.     ·  UNIT=unit-num-of-ser-device (default 0)
  76.     ·  BAUD=baud-rate (default 2400)
  77.     ·  MODEM=modem-name (currently not really used)
  78.     ·  INIT=modem-init-string-for-caller-id-only (Supra's use AT#CID=1)
  79.     ·  OUTPORT=port-to-send-data (default ACIDOUT)
  80.     ·  ANIM=status (OFF/ON, default ON)
  81.     ·  SOUND=status (OFF/ON, default ON)
  82.     ·  ALERT1=path-of-sound-file (no default)
  83.     ·­  ALERT2=path-of-sound-file  (no default)
  84.  
  85.     When ACIDMAN starts, it reads the tool types and initializes the modem.  If you enter the appropriate INIT string, this program should work for all modems, however, I have no actual data from other modems or phone companies to know what to send, and what I will recieve.  When a call is recieved, the data will be sent to an AREXX port, as defined by the tool type OUTPORT.  ACIDMAN & ACIDTEST use the default port of ACIDOUT.  Additionaly, on reciept of a call, there is a sound played, and an animation played.  These can be turned off for low memory systems.  Alert1&2 are used to play special sound files, to help identify calls.  More on this later.
  86.  
  87. ·  Upon execution, the program will open on the workbench.  This program has been designed around the MagicWB look, and works best on a 640x400 Hires Interlaced screen.  Color palette is also set accordingly.  The interface consist of 2 status windows.  The top left window, shows the incomming or last call recieved.  The window below that, shows status information, and a log of all calls received.  This info remains present until the "Clear Log" button is pressed.  "Print Log" will send the file to the PRT: device, but does not clear the log.  The right portion of the interface is reserved for the Caller Data Base.  Currently, the unregistered version will only allow 10 entries.
  88.  
  89. ·  The caller database is the real charm of the program.  Arrow keys scroll you through each entry.  You can quickly search for an entry, by clicking in the search string field, and entering your text.  The search will look at all fields in the database, so you can search by name, number, or comment.  Upon hitting return, the database will be searched, and the first matching entry will be displayed.  Searching occurs from the current entry, to the end of the list, so it is possible no entry will be found the first time, and a second search will have to be done.  If an entry is found, the text and cursor remain in the search field, ready for additional searches.  If no entry is found, a message appears in the log window.
  90.  
  91. At the bottom of the database area are 4 buttons.  These are fairly self expanatory, with the execption of sort.  You can sort the database by name, number, or comment, but you must first click in the sort field, then click on the sort button.  Example, to sort by name, click in the name field, then click the sort button.  Of course, click on the save button if you wish to save the newly sorted list.
  92.  
  93. Above these 4 buttons are some other options.  This is where things get cute.  Each database has the possability of 4 actions, and an option sound file.
  94.  
  95.     ·  Dos'em, will execute a DOS or AREXX script.  When this option is selected, the command field above will unghost.  You can then type in the full DOS or AREXX command.  When a call is recieved and identified, if the Dos'em button is enabled, the command script will be executed.  For arexx, don't for the rx, "rx rexx:testme.rx"
  96.  
  97.     ·  Fak'em, will answer the phone with a modem tone, and then hang up.   I turn this on for those repeat anoying sales calls.  "Olan Mills calling.....screeeeeeeeech....click"
  98.  
  99.     ·  Nuk'em, will answer the phone, then immediatly hang up.   Some people I just don't want to talk to.
  100.  
  101.     ·  Non'em, simply logs the call normally
  102.  
  103.     ·  Alert 1 & Alert 2 will play the sound files defined by the tool types.  This works nice to help identify calls, when you might be in another room.  I use alert 1to identify my girlfriend calling, and alert 2 to identify family members that might call (they probably want to borrow money!)
  104.  
  105. Lastly, is OUTPORT.  The outport tool type and field are used to send the incoming data to other programs.  You might wish to send the info to your database program, so you're clients info is right there in front of you when you pick up the phone.  This would require some arexx programming on your side, but it does work.  The data is sent to the OUTPORT in the format of  NAME&DATE&TIME&COMMENT, using the ampersand as a delimiter.   The outport field will override the OUTPORT tool type, or the default ACIDOUT.  You might wish to set the tool type to the arexx port for your database program.  Any customer who calls, that information could be sent automatically to your database program.  However, non customer calls you may wish to send somewhere else.  If left blank, it will go to the default ACIDOUT, or the tool type specified port.  If you want it to just go into limbo, use NULL in the outport field.  Most people will probably not use this function, and can just leave the field blank, and leave the tool type out.
  106.  
  107. **Note about ports:  They are case sensative, just like Amiga DOS devices.
  108.  
  109. ACIDMAN also has an input Arexx port, defined as ModemOUT.  It will accept to commands:
  110.  
  111.     ·  INQUIRE - will send the data from the last call, to the appropriate outport
  112.  
  113.     ·  QUITSM - will shut down the serial manager, and release the serial device.
  114.  
  115.  
  116. FUTURE ENHANCEMENTS
  117.  
  118. ·  Support for all modem types.  Currently only known to work with Supra's, but may work with others (send me a screen grab of a term program after a call has came in, phone me, or send me other technical data).  The code is in place, all I need is the ASCII strings sent from the modem.  (actually, it may work now, depending on your modem formats the text it send to the serial port).
  119.  
  120. ·  Designed around MagicWB, colors, window location,  and fonts may not look quite right if you're not using MagicWB.
  121.  
  122. ·  Ability to redial last incomming call.
  123.  
  124. ·  Iconify mode, releasing serial device
  125.  
  126. ·  Better error detection and trapping.
  127.  
  128. ·  Amiga Guide documentation (any volunteers?)
  129.  
  130. ·  C= (or whoever it turns out to be) Installer Program support
  131.  
  132. ·  Bug fixes, if any found.
  133.  
  134. ·  Your ideas and suggestions
  135.  
  136. ·  The orginal idea was simply a database, so most of the enhancements planned, have already    been made.
  137.  
  138. Send comments to scorpio@dave-world.net, or write me at my home address below.
  139.  
  140.  
  141. BUGS AND BUMMERS
  142.  
  143. ·  Currently, Caller ID does not cross phone companies, in our area, we have three.  Niether Ameritec, GTE, or Centell pass on the Caller ID info, so many calls I get, reflect a "0" in the number field.  If you live in a large metropolitan area, service by one phone company, this may not be a problem.
  144.  
  145. ·  Currently, Caller ID does not support long distance.  Even when a friend of mine from Chicago, under Ameritec, called one evening,  I still recieved the big zero for the phone number.  He too, had Caller ID.  After further investigation with Ameritec and Illinois bell, I got felt like I'd been through a beurocratic "Circle Jerk.  Here's a brief summary:  Illinois Bell (the long distance company) claimed that Ameritec in Chicago was not passing on the Caller ID information.   Ameritec (the local phone company), claimed they pass the info to Illinois Bell, but Illinois Bell does not pass it on.  Somebody's lying.  But's isn't that just like most utility companies!  (Can you hear the sarcasm in my writing?)
  146.  
  147. ·  Occasionally, entries get deleted from the database.  Not sure why, and haven't seen it happen in the last few revisions.  Maybe it's fixed.  Yah, I think it is.
  148.  
  149. ·  Serial port locks up occasionaly.  Use the Project/Reset menu item to re-initialize the modem.
  150.  
  151. ·  Program fails to open ModemIN port.  Happened on 1 of 4 machines tested.
  152.  
  153. ·  Doesn't appear to like the EGS Spectrum WB emulation mode.  Opens on it's own screen.
  154.  
  155. ·  Other bugs....There's always one, let me know!
  156.  
  157. ACKNOWLEDGEMENTS
  158.  
  159. ·  Commodore, for making a kick but computer!
  160.  
  161. ·  Inovatronics, for CANDO.
  162.  
  163. ·  Supra, for incorporating Caller ID into their Roms.
  164.  
  165. ·  Ameritec, for bring Caller ID to my hometown
  166.  
  167. SPECIAL THANKS
  168.  
  169. ·  My girlfriend Sue, who has been very patient while I finally finished the program
  170.  
  171. ·  My good friend Brian Johnson (A.K.A. Digitizer on the BBS's), who beta tested ACIDMAN and was my human sounding board.  Blame him for the unregister version idea!    :-)
  172.  
  173.  
  174. REGISTRATION:  What do I get for my money?
  175.  
  176. ACIDMAN, the program, not limited in number of database entries
  177. ACIDTEST, the Arexx tester, can work with other programs as well as ACIDMAN
  178. ACIDCODE, a gui based area code database
  179. ACIDCODE-CLI, a cli based area code program (not included in this distribution, I use it in conjunction with Directory Opus)
  180. MagicWB Icons
  181. Pease of mind  (ok, maybe I'm stretching it a bit)
  182.  
  183.  
  184. ·  a measly $20.00 (U.S. funds, cash not recommended)
  185.    (yes it's $19.95 plus a nickle...call BR-549 for all the details)
  186.  
  187. ·  Send check to:   Robert K. Williams
  188.                                   1514 Terrace View Lane
  189.                                   Peoria Hts., Il.  61614
  190.  
  191. ·  Allow 2 weeks for delivery
  192.  
  193.  
  194. DISTRIBUTION (what should be included)
  195.  
  196. ACIDMAN version 1.0 and it's icon (unregistered version)
  197. ACIDTEST version 1.0 and it's icon (it's a freeby)
  198. ACIDCODE version 1.0 and it's icon (another freeby)
  199. serialmanager, a small program to communicate to your serial device
  200. CallerLog.dbf (database of incomming calls and messages)
  201. Phone.dbf (database of stored phone numbers0
  202. Acidcode.dbf (database of area codes0
  203. ACIDMAN.doc (you're reading it!)
  204. ACIDTEST.doc (short but sweet)
  205. ACIDCODE.doc (even shorter yet)
  206.  
  207. If all these files are not present in you're archive, please contact me at scorpio@dave-world.net
  208.  
  209.  
  210. ABOUT THE AUTHOR
  211.  
  212. ·  Degreed in Electronics and Computer Programming, I purchased my first computer (AppleII), in 1978.  Purchased an Amiga 500 sometime in 1987.  Now the proud owner of an Amiga 4000 Toaster System, fully loaded.  Currently self-employed as an 3D animator using Lightwave.
  213. Comments and suggestions can be sent to scorpio@dave-world.net
  214.  
  215. ·  Bored enough?  ok....
  216. THE END
  217.  
  218.